Skip to content

lightningd: unescape log message strings received from plugins #8416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

whitslack
Copy link
Collaborator

Plugins can send arbitrary strings in log notifications. Lightningd was logging these strings without unescaping them, leading to ugly backslashes in the log. Unescape the strings before logging them.

Note: This PR depends on and subsumes #8415.

Checklist

Before submitting the PR, ensure the following tasks are completed. If an item is not applicable to your PR, please mark it as checked:

  • The changelog has been updated in the relevant commit(s) according to the guidelines.
  • Tests have been added or modified to reflect the changes. I don't feel it's necessary to code up a unit test asserting that this issue is fixed, but I will if requested.
  • Documentation has been reviewed and updated as needed. None relevant.
  • Related issues have been listed and linked, including any that this PR closes. None found.

This avoids making an extra copy of the escaped string.

Note that jsonrpc_command_add() no longer accepts usage strings
containing invalid escape sequences. (Previously, it would quietly
accept such a string without unescaping anything.)

Changelog-None
@rustyrussell
Copy link
Contributor

Note that #7013 did some of this work, but the neating is still appreciated!

…ived from plugins

[ Reduced to just neatening, as 23997b2 did
  the unescape handling already -- RR ]
@rustyrussell rustyrussell force-pushed the unescape-plugin-log-msgs branch from 094bdef to 3d66e9e Compare August 15, 2025 01:33
@rustyrussell rustyrussell enabled auto-merge (rebase) August 15, 2025 01:33
@rustyrussell rustyrussell merged commit 3dd0979 into ElementsProject:master Aug 15, 2025
75 of 78 checks passed
@whitslack whitslack deleted the unescape-plugin-log-msgs branch August 15, 2025 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants